Plastics Management API

2.0.x
(0 reviews)

Technical Notes

/connex/card.post

  1. This API has the following required input parameters: the PAN and some card demographic details along with one address of type primary and one member with member number 01.
  2. This API allows the user may add account details to the card when adding a new card by setting the flag includeAccountDetails to true. If the flag is set to false, accounts will not be added even if the accounts are populated.
  3. This API can auto generate a pan in CONNEX by configuring the data the following way: provide a bin and leave the pan field blank.
  4. Note: All objects within the request which consist of a hostValue and description (or status and substatus in case of card status) expect only one of the fields to be populated.
    1. If hostValue is populated, it will be passed as-is to the database.
    2. If the description is populated, the API will instead send the correct backend code to the database.

/connex/card.get

Restriction: The following two values - IncludePrimaryMemberOnly and IncludeAccountDetails - only cannot both be set to true at the same time.

/connex/cvv.get

The CVV GET API provides functionality to retrieve CVV2/CVC2 for accounts when queried.

NOTE:

  1. For this endpoint, the Event Identifier is a CLIENT generated field that is sent back to the requestor. The EventIdentifier field is used to trace the request at the switch end for troubleshooting when issues are found. This is mandatory in the request to generate the Audit trace for the Switch to trace back to the requestor.
  2. Expiration Date Format is both YYYYMM or MMYYYY.

The Key Wrap is the key obtained by the customer using the Encryption API for the Base64 encoded value for their key, which the Client will use to decrypt the encrypted value when received from the API.

  1. The key wrap in the Encryption API is a pre-requisite step for this Connex CVV endpoint for Co-Op clients.
  2. You MUST send a wrappedkey for every Connex CVV Get call, and the Response will return an encrypted CVV code based on the Encryption API's key wrap endpoint.
  3. To decrypt the CVV code, you must use the following JAVA code:
static String decryptClaim(final String key, String claim) throws ParseException, JOSEException {
    JWEObject jweObject = JWEObject.parse(claim);
    byte[] keyBytes = key.getBytes();
    SecretKey secretKey = new SecretKeySpec(keyBytes, 0, keyBytes.length, "AES");
   jweObject.decrypt(new AESDecrypter(secretKey));
    return jweObject.getPayload().toString();
}

The dependency below also need to be added in the JAVA project in order to run the JAVA program:


 <dependency>
   <groupId>com.nimbusds</groupId>
   <artifactId>nimbus-jose-jwt</artifactId>
   <version>5.9</version>
</dependency>

Please refer to the Plastics and PIN Mailer Rush Codes Table for the parameter - rushMailingCode - for the following endpoints:

  • /omaha/pin-mailer
  • /omaha/card-issuance-detail.get
  • /omaha/emboss-plastic
  • /omaha/pending-emboss-orders.get

/omaha/new-account

  • Please refer to the Plastics and PIN Mailer Rush Codes Table for the parameter - rushPlasticCode.
  • Please refer to the Valid U.S. and Canadian Province Codes in the Technical Notes wiki for the Demographics API for this endpoint's input parameter - State.

/omaha/instant-issue

  1. Use this Request API before to GetInstantIssueDetails for EMV chip card instant issuance.
  2. Before calling this Request API, set the Plastic Count to zero (0) for new accounts in order to prevent shipping a card.
  3. This RequestInstantIssuance API will be set the Plastic Count for ordered EMV cards to 1, regardless of the current plastic count.
  4. Allow 2-3 processing days after the Instant Issue request is submitted.

/omaha/instant-issue.get

Instant Issuance is used by Issuers to produce plastics for their cardholders.

This GetInstantIssueDetails API follows the RequestInstantIssuance API call for EMV chip card instant issuance, with a 1-2 minute delay before returning any EMV information. Limit the number of calls to this GetInstantIssueDetails API as each call is billable. Account details can only be retrieved once and cannot be retrieved again by the system once the request is marked.

For this endpoint, the Chip Record Format wiki describes details for the return parameter -

INST_-ISSU-_DATA-_01-_TX.

/omaha/emboss-plastic

This endpoint is also used to enter special handling information when shipping cardholder plastics and plastics-related products when using an overnight courier service. This API is used by Card Issuance Unit (CIU) clients.

This API may be used by Single Entity and Separate Entity clients.

/omaha/emv-script-history.get

The “Record Not Found” error message is returned when no script history is found for the account number.

/omaha/emvChipDetails.get

  • This endpoint would retrieve an array of details for the selected or all available fields for the emv card.
  • This is applicable for both single and separate entity cards.

/omaha/instantIssuanceEmvChipAdd

  • This endpoint would allow you to manually update the EMV chip row for the PI that has been created.
  • Please note that the call should be submitted with presentationInstrumentReplacementSequenceNumber + 1 or you will get a "Record already exists" error message.

  • ChipTypeCode: from Instant Issue local configuration

    1. Set to a value of ‘ONO’ when Offline PIN and offline authorizations are not supported.
    2. Set to a value of ‘PIN’ when Offline PIN is a Cardholder Verification Method (CVM) supported by the chip. This queues a PIN Change script when a PIN change is made on the host system.
    3. Set to a value of ‘ONP’ when Offline PIN is not supported but offline authorizations are supported.

Reviews